home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / icon tools / tooltype / tooltype.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  13KB  |  300 lines
  1. @database ToolType.guide
  2. @master ToolType.guide
  3. @$VER: 3.1
  4. @author "Michael J Barsoom"
  5. @(c) "1994 by Michael J Barsoom"
  6. @index HeddleyAutoIndex
  7. @remark Created with Heddley v1.1 (c) Edd Dumbill 1994
  8. @node "MAIN" "ToolType documentation"
  9.                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10.                            ToolType Release 3.1
  11.                  Copyright 
  12.  1993,1994 by Michael Barsoom
  13.                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14.                            Icon tooltype editor.
  15.     @{"
  16. License
  17. Disclaimer
  18. " link "License_&_Disclaimer" 0}          Legal Issues
  19.     @{"
  20. Introduction
  21. " link "Introduction" 0}          What is ToolType
  22.     @{"
  23. Shareware
  24. " link "Shareware" 0}          How to register ToolType
  25.     @{"
  26. Requirements
  27. " link "Requirements" 0}          What you need to use ToolType
  28.     @{"
  29. Installation
  30. " link "Installation" 0}          How to install ToolType
  31.     @{"
  32. Using
  33. ToolType
  34. " link "Using_ToolType" 0}          Making it work
  35.     @{"
  36. Options
  37. " link "Options" 0}          How to configure ToolType
  38.     @{"
  39. Author
  40. Information
  41. " link "Author" 0}          Bugs, Suggestions, & Registering
  42.     @{"
  43. History
  44. " link "History" 0}          What's changed
  45. @endnode
  46. @node "License_&_Disclaimer" "License and Disclaimer"
  47.                              -+- License  -+-
  48. ToolType is being released under the concept of '@{"Shareware" link "Shareware" 0}'.
  49. ToolType may be freely distributed as long as no charge is made other than to
  50. cover time and copying costs.  If it is to be distributed via floppy disk,
  51. this cost should be no higher than $3.00 (three) dollars US.  If distribution
  52. is via CDRom, the total cost should be no more than Fred Fish charged from one
  53. of his CDRom collections.
  54. You may not copy and/or distribute this program without the accompanying
  55. documentation unless you get permission from the author to do so.
  56. Fred Fish and Walnut Creek have my permission to include this program on their
  57. CDRom collections.
  58. Finally if you wish to include ToolType on a disk magazine you are REQUIRED to
  59. get the author's permission FIRST.  Usually this will require you to just send
  60. me a copy of the issue which contains ToolType free of charge.
  61.                             -+- Disclaimer -+-
  62. This product is sold "as is" without representation or warranty of any kind,
  63. either expressed or implied. The user assumes all risks and responsibilities
  64. related to its use.
  65. @endnode
  66. @node "Introduction" "Introduction"
  67.     What does ToolType do?
  68. ToolType will allow you to edit tooltypes in icons using your favorite text
  69. editor, rather than that silly string gadget intuition gives you in the
  70. information requester
  71. ToolType can sort the tooltypes alphabetically, placing commented icons first
  72. or last in the sorted list.
  73. ToolType can be set up as an appicon for on the fly tooltype editing.
  74. ToolType will automatically comment or uncomment tooltypes for you, all you
  75. have to do is mark tooltypes to be commented with a '(' or delete the '(' to
  76. uncomment them.
  77. ToolType can take a textfile with tooltypes in it and put them in an icon.
  78. This feature is usefull if you need to add the same tooltypes to several
  79. icons.  This can easily be done by using a batch file or a 'For' command.
  80. Users of Nicola Salmoria's NewIcon package will still be able to use ToolType
  81. without loosing any of the palette information, newicon image or oldicon
  82. image.  These features will be available weather or not you have the NewIcons
  83. patch running, provided you have newicons.library installed.
  84. @endnode
  85. @node "Shareware" "ShareWare"
  86. PLEASE SUPPORT SHAREWARE!
  87. ToolType is shareware, you can use all the options and features of ToolType
  88. without any limitations.  ToolType is not crippled in any manner. After an
  89. evaluation period of 30 days, if you want to still use ToolType you are asked
  90. to register.
  91. The following is the current price list for ToolType.
  92.     $5.00 US.
  93. Please see @{"Author
  94. Info" link "Author" 0}, for information on contacting me and my address to
  95. send in your registration
  96. Sending in your registration fee will help ensure futhor developement of
  97. ToolType.  Also I will give priority to suggestions and questions from
  98. register users.
  99. Please note in the time that ToolType has be released I have received only one
  100. registration.  As this version involved a complete rewrite and I have no use
  101. for a localized version, all locale support was removed.  If I receive enough
  102. requests/registration I would be glad to put it back.
  103. @endnode
  104. @node "Requirements" "Requirements"
  105. ToolType does not require much in order to work.  You will however need to
  106. have the following items installed or available on your Amiga to use
  107. ToolType.
  108.  1) Workbench 2.0+
  109.  2) ReqTools library (
  110.  Nico Francois) not included
  111.  3) A text editor
  112.  4) some icons.
  113. Optional
  114.  1) NewIcon.library (
  115.  Nicola Salmoria) not included
  116. @endnode
  117. @node "Installation" "Installation"
  118.                             Installing ToolType
  119.                            ~~~~~~~~~~~~~~~~~~~~~
  120. Nothing could be easier.  Just make sure you have ReqTools in libs: and place
  121. ToolType where ever you want.  If your going to use the appicon feature, I
  122. recommend placing it in WBStartup.
  123. @endnode
  124. @node "Using_ToolType" "Using ToolType"
  125.   Using ToolType
  126.   **************
  127. Using ToolType is very easy.  First just make sure you have configured
  128. ToolType to you system and liking.  
  129. You can start ToolType in any of the following ways:
  130. 1) ToolType can be started without any arguments from either Workbench or
  131. shell.  In this case you will be presented with a filerequester.  Just select
  132. the icon you wish to edit with the requester.
  133. 2) If you start ToolType with and argument, either from Workbench (via extend
  134. selecting) or and a cli arguement from your favorite shell.
  135. 3) If you start ToolType with the AppIcon option on, ToolType will place an
  136. appicon on your Workbench window.  Now all you have to do is drop your icons
  137. on the appicon to edit them.  You  can also double click on the appicon to
  138. select icon with a file requester.  If you cancel the file requester, you will
  139. be presented with a information requester with the option to quit.
  140. Reguardless of which method you use to start ToolType, your text editor will
  141. be run and the tempfile created, which contains all the tooltypes, will be
  142. loaded.  Each line represents a different tooltype.  Just edit the tool types
  143. as you would any other text file.  When you are done, save the changes and
  144. ToolType will read the tempfile, extract the ToolTypes and save them to the
  145. icon.
  146. NOTES:  Blank lines in the the text file will be ignored.  A blank line is
  147.         any line which begins with a space or a carriage return.
  148.          Limitations:    
  149.  1) ToolType is limited to 256 tooltypes (If you need more let me know)
  150.  2) Workbench limits tooltype lengths to 128 chars.
  151. @endnode
  152. @node "Options" "Options"
  153.                                   Options
  154.                                  ~~~~~~~~~
  155. Options can be specified in the tooltypes (when starting from the Workbench)
  156. or on the command line (when starting from a Shell).
  157.   EDITOR
  158.     Command string you run your text editor.  Tooltype will look in you
  159.     Workbench path to find your editor.  If your editor is not located in
  160.     Workbench's path or if Workbench is not running, then you will need to
  161.     include the complete path.  If your text editor runs asynchronously you
  162.     also need to specify the WAIT option.  ToolType will automatically
  163.     place the name of the tempfile at the end of the command strings.  If
  164.     you need this to be in the middle, put a `%s' in the command string to
  165.     specify where the name of the temporary file should be inserted.
  166.     If you do not specify this option ToolType will read the environment
  167.     variable 'ToolType' if this does not exist it will try the variable
  168.     'Editor'.  If all the above fail it will default to using 'ED %s'
  169.   SORT
  170.     This options describes how you wish to handle sorting of the tooltype.
  171.     The choices are:
  172.         Ask - pop up a requester each time you edit an icon if you wish
  173.               the tooltypes to be sorted.
  174.        True - always sort the tooltypes.
  175.       False - never sort the tooltypes.
  176.     The default is Ask.
  177.   WAIT
  178.     Some text editors run asynchronously, that is they detach from the shell
  179.     when run.  If your text editor does this, you need to specify this
  180.     option.  When is set, a requester asking if you are done editing the
  181.     tempfile will appear.  Click on it only after you have finished editing
  182.     the tempfile and have saved the changes
  183.     Default is off.
  184.   CONFIRM
  185.     If you wish to be asked if it is OK to change the tooltypes in the icon,
  186.     set this tooltype.  ToolType will check the creation date of the tempfile
  187.     before it runs the text editor and again after.  Only if the date
  188.     changes, will the confirmation requester appear.
  189.     Default is off.
  190.   COMMENT 
  191.     When sorting the tooltypes, the commented ones those surrounded by '('
  192.     ')', will be placed after the uncommented ones.  Setting this option
  193.     tells ToolType to place the commented ones first not last.  This
  194.     options only works if the tooltypes are being sorted.
  195.     Default to is place the commented tooltypes last.
  196.   PUBSCREEN
  197.     This option specifies name of public screen requesters should appear
  198.     on, if not specified or the name is invalid, Workbench will be used.
  199.     Default is 'Workbench'
  200.   QUIET
  201.     This option suppress the copyright notice when ToolType is started from
  202.     WorkBench.
  203.   APPICON
  204.     This option tells ToolType to add an appicon to the Workbench.
  205.   ICONX
  206.     This options lets you specify the horizontal position of the appicon.
  207.     Default is to let Workbench pick the location.
  208.   ICONY
  209.     This options lets you specify the vertical position of the appicon
  210.     Default is to let Workbench pick the location.
  211.   ICONNAME
  212.     This option lets you specify the name that should appear under the
  213.     appicon on the Workbench screen.
  214.     Default is 'ToolType'
  215.   FILE
  216.           This option is only available from the CLI.  Use this option to
  217. specify
  218.           a text file which would contain tooltypes to add to icons. ToolType
  219.           will read the text file and change the icon's tooltypes to those
  220.           specified in the text file.
  221. @endnode
  222. @node "Locale" "Locale"
  223.  Locale Support
  224.  **************
  225. This feature has been removed in v3.0.  If there are enough
  226. requests/registrations I will put it back.
  227. @endnode
  228. @node "Author" "Author Information"
  229.  Author information
  230.     I can be reached at any of the following.
  231.   Snail mail:
  232.     Michael J Barsoom
  233.     5524 Pine Street
  234.     Omaha NE
  235.     68106
  236.     USA
  237.   E-Mail
  238.     Internet:  mbars@bluejay.creighton.edu 
  239.     Fidonet:   Mike Barsoom @ 1:285/11.9
  240.     AmigaNet:  Mike Barsoom @ 40:200/10.9
  241. @endnode
  242. @node "History" "History"
  243.  Release 3.1
  244.     o ToolType now supports NewIcons, provided you have newicon.library
  245.       installed.
  246.  Release 3.0a
  247.     o CONFIRM switch was not working (fixed)
  248.     o Will now look for your text editor in your Workbench path, you
  249.       no longer have to specify the whole path for editor command 
  250.       string.
  251.  Release 3.0
  252.     o Found a bug which I could not figure out.  So I rewrote the whole
  253.       thing. Result was an executable which what much shorter in length.
  254.     o Removed locale support, if you want it back concider registering.
  255.     o Rewrote docs, now much easier to read
  256.  Prior Versions
  257.     o Ancient history
  258. @endnode
  259. @node HeddleyAutoIndex "Index"
  260. @remark Index auto-generated by Heddley
  261. Index of database ToolType.guide
  262. Documents
  263. @{"Author Information" link "Author"}
  264. @{"History" link "History"}
  265. @{"Installation" link "Installation"}
  266. @{"Introduction" link "Introduction"}
  267. @{"License and Disclaimer" link "License_&_Disclaimer"}
  268. @{"Locale" link "Locale"}
  269. @{"Options" link "Options"}
  270. @{"Requirements" link "Requirements"}
  271. @{"ShareWare" link "Shareware"}
  272. @{"ToolType documentation" link "MAIN"}
  273. @{"Using ToolType" link "Using_ToolType"}
  274. Buttons
  275. Author
  276. Information
  277. " link "Author" 0}
  278. History
  279. " link "History" 0}
  280. Installation
  281. " link "Installation" 0}
  282. Introduction
  283. " link "Introduction" 0}
  284. License
  285. Disclaimer
  286. " link "License_&_Disclaimer" 0}
  287. Options
  288. " link "Options" 0}
  289. Requirements
  290. " link "Requirements" 0}
  291. Shareware
  292. " link "Shareware" 0}
  293. Using
  294. ToolType
  295. " link "Using_ToolType" 0}
  296. @{"Author
  297. Info" link "Author" 0}
  298. @{"Shareware" link "Shareware" 0}
  299. @endnode
  300.